Skip to content

Honkit migration - #671

Merged
kenhys merged 13 commits into
1.0from
honkit-migration
Aug 10, 2026
Merged

Honkit migration#671
kenhys merged 13 commits into
1.0from
honkit-migration

Conversation

@kenhys

@kenhys kenhys commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

To fix #659, migrate to Netlify as same as fluentd-website.

  • Use honkit to reduce migration cost
  • Best effort to keep compatibility with gitbook layout
  • Use _redirect to replace .gitbook.yaml redirects.
  • Simplify footer with localized-footer plugin
  • Introduce package-lock.json to hold them
  • Specify [[redirects]] to show image resources in netlify.toml

kenhys and others added 9 commits August 8, 2026 21:23
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
@netlify

netlify Bot commented Aug 8, 2026

Copy link
Copy Markdown

Deploy Preview for fluentd-docs ready!

Name Link
🔨 Latest commit c033e25
🔍 Latest deploy log https://app.netlify.com/projects/fluentd-docs/deploys/6a772d9677d83c00088a5a4c
😎 Deploy Preview https://deploy-preview-671--fluentd-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

kenhys added 2 commits August 8, 2026 21:45
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
  codespell package-lock.json
  package-lock.json:1343: liNs ==> lines, links, lions, loins, limns
  1

Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
@kenhys
kenhys force-pushed the honkit-migration branch 2 times, most recently from 06acea6 to 75df6bd Compare August 8, 2026 13:05
kenhys added 2 commits August 8, 2026 22:22
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
@kenhys
kenhys force-pushed the honkit-migration branch from 75df6bd to c033e25 Compare August 8, 2026 13:22
@kenhys
kenhys marked this pull request as draft August 8, 2026 13:22
@kenhys
kenhys marked this pull request as ready for review August 8, 2026 13:30
@kenhys
kenhys requested a review from Watson1978 August 10, 2026 01:16

@Watson1978 Watson1978 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These can be fixed later, so I don't think they should block merging this PR.

0.12

  • The images are not displayed.

    • They are embedded as ![](../.gitbook/assets/xxxx), so the generated pages request /0.12/.gitbook/assets/.... The redirect rule in netlify.toml only matches the site root (from = "/.gitbook/assets/*"), so nothing rewrites the versioned paths and they end up as 404. The files themselves are in place: /0.12/assets/apache-to-mongodb.png returns 200.

    • Ref. https://deploy-preview-671--fluentd-docs.netlify.app/0.12/articles/apache-to-mongodb.html

    • Adding rules for the sub-books would fix it:

      [[redirects]]
        from = "/0.12/.gitbook/assets/*"
        to = "/0.12/assets/:splat"
        status = 200
      
      [[redirects]]
        from = "/1.0/.gitbook/assets/*"
        to = "/1.0/assets/:splat"
        status = 200
  • The 0.12 pages are titled <title>Getting Started · Fluentd 1.0 Documentation</title>. It would be better to show 0.12 here. This seems to come from scripts/build.sh, which copies the 1.0 book.json into the 0.12 worktree and overwrites its own "title": "Fluentd v0.12 Documentation".

  • The raw markdown files are deployed, which is unnecessary.

@kenhys

kenhys commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Thanks, I'll fix them in another PR.

@kenhys
kenhys merged commit ac9a592 into 1.0 Aug 10, 2026
6 checks passed
@kenhys
kenhys deleted the honkit-migration branch August 10, 2026 02:10
kenhys pushed a commit that referenced this pull request Aug 10, 2026
HonKit builds heading ids differently from GitBook: it drops backticks,
`<`, `>` and `_` from the heading text. The links written for GitBook
therefore stopped resolving once #671 and #672 made HonKit the renderer
for the published site.

| heading                     | GitBook id                             | HonKit id      |
| --------------------------- | -------------------------------------- | -------------- |
| `### `add_http_headers``    | add_http_headers                       | addhttpheaders |
| `### `<inject>` Section`    | less-than-inject-greater-than-section  | inject-section |

15 links across 6 files, 8 distinct anchors:

* input/http.md               #add_http_headers, #decompression_size_limit
* input/syslog.md             #source_host_key
* output/http.md              #allowed_hosts
* output/exec_filter.md       #less-than-{inject,extract}-greater-than-section
* output/file.md              #less-than-buffer-greater-than-section
* deployment/system-config.md #less-than-source_only_buffer-greater-than-section

Verified by building the site with the repository's own configuration and
matching every `href="#..."` against the `id=` and `name=` attributes on
the same page. Before this change 8 of the 2366 in-page anchors did not
resolve; after it, none are left.

The new ids were read out of the generated HTML rather than derived from
the rule by hand.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs.fluentd.org (via GitBook) is out-of-sync

2 participants